Update index.md with an overview section #243
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I think this should probably roughly match the Current feature set from the README. |
iamed2
reviewed
Jan 31, 2022
| ## Examples | ||
| The below examples assume you already have a database created. If you don't have one setup yet, you will need to do so for the following snippets to work. |
There was a problem hiding this comment.
Suggested change
| The below examples assume you already have a database created. If you don't have one setup yet, you will need to do so for the following snippets to work. | |
| The below examples assume you already have a database created. If you don't have one setup yet, you will need to do so for the following snippets to work. |
Comment on lines
+12
to
+25
| * Build | ||
| * Installs `libpq` via `BinaryBuilder.jl` for MacOS, GNU Linux, and Windows | ||
| * Connections | ||
| * Connect via DSN | ||
| * Connect via PostgreSQL connection string | ||
| * UTF-8 client encoding | ||
| * Queries | ||
| * Create and execute queries with or without parameters | ||
| * Execute queries asynchronously | ||
| * Stream results using [Tables](https://github.com/JuliaData/Tables.jl) | ||
| * Configurably convert a variety of PostgreSQL types to corresponding Julia types (see the **Type Conversions** section of the docs) | ||
| * Prepared Statements | ||
| * Create and execute prepared statements with or without parameters | ||
| * Stream table of parameters to execute the same statement multiple times with different data |
There was a problem hiding this comment.
Needs adjustment to match the wording of the pre-colon sentence. E.g.:
Suggested change
| * Build | |
| * Installs `libpq` via `BinaryBuilder.jl` for MacOS, GNU Linux, and Windows | |
| * Connections | |
| * Connect via DSN | |
| * Connect via PostgreSQL connection string | |
| * UTF-8 client encoding | |
| * Queries | |
| * Create and execute queries with or without parameters | |
| * Execute queries asynchronously | |
| * Stream results using [Tables](https://github.com/JuliaData/Tables.jl) | |
| * Configurably convert a variety of PostgreSQL types to corresponding Julia types (see the **Type Conversions** section of the docs) | |
| * Prepared Statements | |
| * Create and execute prepared statements with or without parameters | |
| * Stream table of parameters to execute the same statement multiple times with different data | |
| * Install `libpq` | |
| * Installs `libpq` via `BinaryBuilder.jl` for MacOS, GNU Linux, and Windows | |
| * Create Connections | |
| * Connect via DSN | |
| * Connect via PostgreSQL connection string | |
| * UTF-8 client encoding | |
| * Run Queries | |
| * Create and execute queries with or without parameters | |
| * Execute queries asynchronously | |
| * Stream results using [Tables](https://github.com/JuliaData/Tables.jl) | |
| * Configurably convert a variety of PostgreSQL types to corresponding Julia types (see the **Type Conversions** section of the docs) | |
| * Use Prepared Statements | |
| * Create and execute prepared statements with or without parameters | |
| * Stream table of parameters to execute the same statement multiple times with different data |
| @@ -5,7 +5,32 @@ | |||
| [](https://travis-ci.com/invenia/LibPQ.jl) | |||
| [](https://codecov.io/gh/invenia/LibPQ.jl) | |||
|
|
|||
| ## Overview | |||
|
|
|||
| LibPQ.jl is a Julia wrapper for the PostgreSQL libpq C library. It provides the ability to: | |||
There was a problem hiding this comment.
Suggested change
| LibPQ.jl is a Julia wrapper for the PostgreSQL libpq C library. It provides the ability to: | |
| LibPQ.jl is a Julia wrapper for the PostgreSQL `libpq` C library. It provides the ability to: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.